Vizbl SDK/com.us.vizbl.ar.sdk.api/VizblAR

VizblAR

class VizblAR : VizblARController

Types

Companion

object Companion

Properties

lastAddedInstanceId

open override val lastAddedInstanceId: InstanceId?

The unique identifier of the most recently added instance, or null if no instances have been added.

placedObjects

open override val placedObjects: List<ARPlacedObject>

The collection of all 3D objects currently placed within the AR scene.

selectedInstanceId

open override val selectedInstanceId: InstanceId?

The unique identifier of the currently selected instance, or null if no instance is selected.

viewConfiguration

open override val viewConfiguration: ARViewConfiguration

The current configuration for AR view layers and visual settings. Defines how the 3D content and UI overlays are rendered.

Functions

add

open suspend override fun add(model: ARObjectReference, configuration: ARObjectConfiguration.() -> Unit): InstanceId

Adds a new 3D object to the AR scene using a model reference.

capture

open override fun capture(view: SurfaceView, fileName: String?, onSuccess: (Uri) -> Unit)

Captures the current frame of the specified SurfaceView and saves it to storage.

captureAndShare

open override fun captureAndShare(view: SurfaceView, text: String?, onSuccess: (Uri) -> Unit)

Captures the current frame of the specified SurfaceView and launches a system share dialog.

clearCache

open override fun clearCache()

Clears all cached resources utilized by the AR session.

dismiss

open override fun dismiss()

Closes the AR experience and releases associated resources.

pauseSession

open override fun pauseSession()

Pauses the current AR session, halting rendering and tracking.

remove

open override fun remove(instanceId: InstanceId)

Removes a placed object from the scene using its instance identifier.

removeAll

open override fun removeAll()

Removes all placed objects from the current scene.

replace

open suspend override fun replace(instanceId: InstanceId, with: ARObjectReference, configuration: ARObjectConfiguration.() -> Unit): InstanceId

Replaces an existing AR object with a new one.

resumeSession

open override fun resumeSession()

Resumes a previously paused AR session.

setSession

fun setSession(session: Session)

Updates the current Session.

startQRScanner

open override fun startQRScanner()

Initializes and starts the QR code scanning process using the device camera.

stopCapture

open override fun stopCapture()

Cancels any ongoing screen capture operation.